<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>DDL Generator</title>
<style type="text/css">@import url("file:/C:/Users/cse/work/eclipse-run/eclipse-rcp-helios-SR2/configuration/org.eclipse.osgi/bundles/204/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/C:/Users/cse/work/eclipse-run/eclipse-rcp-helios-SR2/configuration/org.eclipse.osgi/bundles/216/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">DDL Generator</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>com.byterefinery.rmbench.DDLGenerator<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point allows for the specification of the DDL generation process during model export. It consists of a group of classes that cooperate by covering different aspects of DDL script generation. Specifically, these are:
<ul>
<li>the DDL generator: <code>com.byterefinery.rmbench.extension.IDDLGenerator</code></li>
<li>the configuration wizard: <code>com.byterefinery.rmbench.extension.IDDLGeneratorWizardFactory</code></li>
<li>the DDL code formatter: <code>com.byterefinery.rmbench.extension.IDDLFormatter</code></li>
<li>the DDL script: <code>com.byterefinery.rmbench.extension.IDDLScript</code></li>
</ul>
See the respective class documentation for a description of their responsibilities<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.generator">generator</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.generator">generator</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST generator</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">factory&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">databases&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">excludeDatabases&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">wizardFactory&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">formatter&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA "com.byterefinery.rmbench.export.DefaultFormatter$Factory"</p><p class="code SchemaDtdAttlist">script&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA "com.byterefinery.rmbench.export.DDLScript$Factory"</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
a DDL generator generates DDL statemes for a specific database during model export</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - unique ID of this extension</li>
<li><b>name</b> - displayable name of this extension</li>
<li><b>factory</b> - the name of a class that implements the <code>com.byterefinery.rmbench.extension.IDDLGenerator.Factory</code> interface</li>
<li><b>databases</b> - comma-separated list of ids of database products that are supported by this generator. The special token "*" can be used to represent all database products</li>
<li><b>excludeDatabases</b> - Comma-separated list of ids of database products that are not supported by this generator. This is only used if you set "*" to the datases attribute.</li>
<li><b>wizardFactory</b> - a reference to a class that implements the <code>com.byterefinery.rmbench.extension.IDDLGeneratorWizardFactory</code> interface, which can optionally be used to provide a configuration wizard page for the DDL generator</li>
<li><b>formatter</b> - a reference to a class that implements the <code>com.byterefinery.rmbench.extension.IDDLFormatter.Factory</code> interface, which is used to create a DDL formatter associated with this DDL generator. If not specified, the default formatter will be used</li>
<li><b>script</b> - a reference to a class that implements the <code>com.byterefinery.rmbench.extension.IDDLScript.Factory</code> interface, which is used to create IDDLScript instances during DDL generation</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension
      point=</span><span class="code SchemaCstring">&quot;com.mycorp.DDLGenerator&quot;</span><span class="code SchemaTag">&gt;
   &lt;generator
         factory=</span><span class="code SchemaCstring">&quot;com.mycorp.DDLGeneratorFactory&quot;</span><span class="code SchemaTag">
         databases=</span><span class="code SchemaCstring">&quot;*&quot;</span><span class="code SchemaTag">
         id=</span><span class="code SchemaCstring">&quot;mycorp&quot;</span><span class="code SchemaTag">
         name=</span><span class="code SchemaCstring">&quot;MyCorp specialized DDL generator&quot;</span><span class="code SchemaTag">
         wizard=</span><span class="code SchemaCstring">&quot;com.mycorp.DDLGeneratorWizardFactory&quot;</span><span class="code SchemaTag">/&gt;
&lt;/extension&gt;
</span></pre>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>the class must implement the <code>com.byterefinery.rmbench.extension.IDDLGenerator</code> interface
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>RMBEnch comes with DDL generator implementations for all supported database products
<p></p>

<br>
<p class="note SchemaCopyright">
(c) 2009, ByteRefinery

</p>
</BODY>
</HTML>
